Get Projects (AI Hub)
(Admin Tools)
Synopsis
This operator gets a list of all Projects on an AI Hub.Description
This operator retrieves a list of all Projects on an AI Hub in creation date order. This list contains the exact the same information as the Projects page within the AI Hub web interface. For each job, the resulting ExampleSet contains a job id, queueName, process name, displayName, description, createdAt, cloneUrl, uid, permissions as JSON.
As with other operators in this extension, the input of this operator requires an AI Hub Connection IOObject with sufficient information and credentials (server_url, client_secret, and refresh_token) to access the AI Hub API. You can create an AI Hub connection IOObject in Studio by going to Create Connections selection in the Connections menu. The client_secret and refresh tokens can be obtained by logging to the AI Hub as an administrator in the web interface and then directly navigating to this URL: [server_url]/get-token. If all the information is entered correctly, a new AI Hub Connection IOObject will appear in the Connections folder of your repository. This Connection IOObject now can be connected to any Admin extension operator con input port when needed.
Input
con (Connection)An AI Hub Connection IOObject.
Output
- con
The AI Hub Connection IOObject from the input port, delivered as a passthru.
exa (Data table)An ExampleSet containing information about all Projects that exist on an AI Hub.
Parameters
- page A page number of the list, expressed as an integer e.g. 1, 2, 3. Range:
- size The maximum size of the returned list, expressed as an integer e.g. 1, 2, 3. Defaults to 1024. Range:
- include_archived If set to true archived Projects will also be shown. Defaults to false. Range: